package org.codehaus.modello;

/*
 * Copyright (c) 2005, Codehaus.org
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import java.io.File;
import java.io.IOException;
import java.io.Reader;
import java.util.Optional;
import java.util.Properties;

import org.codehaus.plexus.PlexusTestCase;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.ReaderFactory;

/**
 * Abstract class for Modello plugins unit-tests that check output generated by the plugin.
 *
 * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
 */
public abstract class AbstractModelloGeneratorTest
    extends PlexusTestCase
{
    private String name;

    protected AbstractModelloGeneratorTest( String name )
    {
        this.name = name;
    }

    protected void setUp()
        throws Exception
    {
        super.setUp();

        FileUtils.deleteDirectory( getOutputDirectory() );

        assertTrue( getOutputDirectory().mkdirs() );
    }

    protected File getOutputDirectory()
    {
        return getTestFile( "target/generator-results/" + getName() );
    }

    public String getName()
    {
        return name;
    }

    protected Properties getModelloParameters()
    {
        Properties parameters = new Properties();

        parameters.setProperty( "modello.output.directory", getOutputDirectory().getAbsolutePath() );

        return parameters;
    }

    protected Properties getModelloParameters( String version )
    {
        Properties parameters = getModelloParameters( version, null );

        return parameters;
    }

    protected Properties getModelloParameters( String version, Integer javaSource )
    {
        Properties parameters = getModelloParameters();

        parameters.setProperty( "modello.package.with.version", Boolean.toString( false ) );
        parameters.setProperty( "modello.version", version );
        Optional.ofNullable( javaSource ).ifPresent( a -> parameters.setProperty( "modello.output.java.source",
                                                                                  Integer.toString( a ) ) );

        return parameters;
    }

    protected Reader getXmlResourceReader( String name )
        throws IOException
    {
        return ReaderFactory.newXmlReader( getClass().getResourceAsStream( name ) );
    }
}
